home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmClipboardEndCopy.z / XmClipboardEndCopy
Encoding:
Text File  |  2002-10-03  |  5.5 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy - A clipboard function that completes the
  10.           copying of data to the clipboard
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/CutPaste.h>
  14.           int XmClipboardEndCopy (_d_i_s_p_l_a_y, _w_i_n_d_o_w, _i_t_e_m__i_d)
  15.                   Display * _d_i_s_p_l_a_y;
  16.                   Window  _w_i_n_d_o_w;
  17.                   long    _i_t_e_m__i_d;
  18.           (vvvvooooiiiidddd)
  19.  
  20.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  21.           This page documents Motif 2.1.
  22.  
  23.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy locks the clipboard from access by other
  25.           applications, places data in the clipboard data structure,
  26.           and unlocks the clipboard.  Data items copied to the
  27.           clipboard by XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy are not actually entered in the
  28.           clipboard data structure until the call to
  29.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy.
  30.  
  31.           This function also frees up temporary storage that was
  32.           allocated by XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy, which must be called
  33.           before XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy. The latter function should not be
  34.           called if XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCaaaannnncccceeeellllCCCCooooppppyyyy has been called.
  35.  
  36.           _d_i_s_p_l_a_y   Specifies a pointer to the DDDDiiiissssppppllllaaaayyyy structure that
  37.                     was returned in a previous call to XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy or
  38.                     XXXXttttDDDDiiiissssppppllllaaaayyyy.
  39.  
  40.           _w_i_n_d_o_w    Specifies the window ID of a widget that relates
  41.                     the application window to the clipboard. The
  42.                     widget's window ID can be obtained through
  43.                     XXXXttttWWWWiiiinnnnddddoooowwww.  The same application instance should
  44.                     pass the same window ID to each clipboard function
  45.                     it calls.
  46.  
  47.           _i_t_e_m__i_d   Specifies the number assigned to this data item,
  48.                     which was returned by a previous call to
  49.                     XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy.
  50.  
  51.      RRRREEEETTTTUUUURRRRNNNN
  52.           _X_m_C_l_i_p_b_o_a_r_d_S_u_c_c_e_s_s
  53.                     The function was successful.
  54.  
  55.           _X_m_C_l_i_p_b_o_a_r_d_L_o_c_k_e_d
  56.                     The function failed because the clipboard was
  57.                     locked by another application. The application can
  58.                     continue to call the function again with the same
  59.                     parameters until the lock goes away. This gives
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     the application the opportunity to ask if the user
  75.                     wants to keep trying or to give up on the
  76.                     operation.
  77.  
  78.           _X_m_C_l_i_p_b_o_a_r_d_F_a_i_l
  79.                     The function failed because XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy
  80.                     was not called.
  81.  
  82.      RRRREEEELLLLAAAATTTTEEEEDDDD
  83.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCaaaannnncccceeeellllCCCCooooppppyyyy(3), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy(3) and
  84.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy(3).
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.